<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>observable.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_labs_observe_observable.js.html">observable.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2012 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview Experimental observer-observable API. This is
<a name="line17"></a> * intended as super lightweight replacement of
<a name="line18"></a> * goog.events.EventTarget when w3c event model bubble/capture
<a name="line19"></a> * behavior is not required.
<a name="line20"></a> *
<a name="line21"></a> * This is similar to {@code goog.pubsub.PubSub} but with different
<a name="line22"></a> * intent and naming so that it is more discoverable. The API is
<a name="line23"></a> * tighter while allowing for more flexibility offered by the
<a name="line24"></a> * interface {@code Observable}.
<a name="line25"></a> *
<a name="line26"></a> * WARNING: This is still highly experimental. Please contact author
<a name="line27"></a> * before using this.
<a name="line28"></a> *
<a name="line29"></a> */
<a name="line30"></a>
<a name="line31"></a>goog.provide(&#39;goog.labs.observe.Observable&#39;);
<a name="line32"></a>
<a name="line33"></a>goog.require(&#39;goog.disposable.IDisposable&#39;);
<a name="line34"></a>
<a name="line35"></a>
<a name="line36"></a>
<a name="line37"></a>/**
<a name="line38"></a> * Interface for an observable object.
<a name="line39"></a> * @interface
<a name="line40"></a> * @extends {goog.disposable.IDisposable}
<a name="line41"></a> */
<a name="line42"></a>goog.labs.observe.Observable = function() {};
<a name="line43"></a>
<a name="line44"></a>
<a name="line45"></a>/**
<a name="line46"></a> * Registers an observer on the observable.
<a name="line47"></a> *
<a name="line48"></a> * Note that no guarantee is provided on order of execution of the
<a name="line49"></a> * observers. For a single notification, one Notice object is reused
<a name="line50"></a> * across all invoked observers.
<a name="line51"></a> *
<a name="line52"></a> * Note that if an observation with the same observer is already
<a name="line53"></a> * registered, it will not be registered again. Comparison is done via
<a name="line54"></a> * observer&#39;s {@code equals} method.
<a name="line55"></a> *
<a name="line56"></a> * @param {!goog.labs.observe.Observer} observer The observer to add.
<a name="line57"></a> * @return {boolean} Whether the observer was successfully added.
<a name="line58"></a> */
<a name="line59"></a>goog.labs.observe.Observable.prototype.observe = function(observer) {};
<a name="line60"></a>
<a name="line61"></a>
<a name="line62"></a>/**
<a name="line63"></a> * Unregisters an observer from the observable. The parameter must be
<a name="line64"></a> * the same as those passed to {@code observe} method. Comparison is
<a name="line65"></a> * done via observer&#39;s {@code equals} method.
<a name="line66"></a> * @param {!goog.labs.observe.Observer} observer The observer to remove.
<a name="line67"></a> * @return {boolean} Whether the observer is removed.
<a name="line68"></a> */
<a name="line69"></a>goog.labs.observe.Observable.prototype.unobserve = function(observer) {};
<a name="line70"></a>
<a name="line71"></a>
<a name="line72"></a>/**
<a name="line73"></a> * Notifies observers by invoking them. Optionally, a data object may be
<a name="line74"></a> * given to be passed to each observer.
<a name="line75"></a> * @param {*=} opt_data An optional data object.
<a name="line76"></a> */
<a name="line77"></a>goog.labs.observe.Observable.prototype.notify = function(opt_data) {};
</pre>


</body>
</html>
